<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>Euro-Truck-Simulator-2-Lane-Assist.src.loading API documentation</title>
<meta name="description" content="Provides a loading window with a progress bar and a text label …" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/ir-black.min.css" crossorigin>
<style>
:root {
--highlight-color: #202;
}
html {
scrollbar-face-color: #646464;
scrollbar-base-color: #646464;
scrollbar-3dlight-color: #646464;
scrollbar-highlight-color: #646464;
scrollbar-track-color: #000;
scrollbar-arrow-color: #000;
scrollbar-shadow-color: #646464;
scrollbar-dark-shadow-color: #646464;
}
::-webkit-scrollbar { width: 14px; height: 3px;}
::-webkit-scrollbar-button {
background-color: #000;
height: 3px;}
::-webkit-scrollbar-track {
background-color: #646464;}
::-webkit-scrollbar-track-piece { background-color: #000;}
::-webkit-scrollbar-thumb { height: 50px; background-color: #666; border-radius: 7px;}
::-webkit-scrollbar-corner { background-color: #646464;}
::-webkit-resizer { background-color: #666;}
.flex {
display: flex !important;
}
body {
line-height: 1.5em;
color: #fff;
background-color: #1e1e1e;
font: 14px/1.5 Helvetica, Arial, sans-serif;
margin: 0;
padding: 0;
}
#content {
padding: 20px;
}
#sidebar {
padding: 30px;
overflow: hidden;
}
#sidebar>*:last-child {
margin-bottom: 2cm;
}
.http-server-breadcrumbs {
font-size: 130%;
margin: 0 0 15px 0;
}
#footer {
font-size: .75em;
padding: 5px 30px;
border-top: 1px solid #fff;
text-align: right;
}
#footer p {
margin: 0 0 0 1em;
display: inline-block;
}
#footer p:last-child {
margin-right: 30px;
}
h1,
h2,
h3,
h4,
h5 {
font-weight: 300;
color: #fff;
}
h1 {
font-size: 2.5em;
line-height: 1.1em;
}
h2 {
font-size: 1.75em;
margin: 1em 0 .50em 0;
}
h3 {
font-size: 1.4em;
margin: 25px 0 10px 0;
}
h4 {
margin: 0;
font-size: 105%;
}
h1:target,
h2:target,
h3:target,
h4:target,
h5:target,
h6:target {
background: #1e1e1e;
padding: 0.2em 0;
}
a {
color: #8fd6fc;
text-decoration: none;
transition: color .3s ease-in-out;
}
a:hover {
color: #00a4fc;
}
.title code {
font-weight: bold;
}
h2[id^="header-"] {
margin-top: 2em;
}
.ident {
color: #f6fc85;
}
strong {
color: #8fd6fc;
}
pre code {
background: transparent;
font-size: .8em;
line-height: 1.4em;
}
code {
background: rgba(255, 255, 255, 0.1);
padding: 1px 4px;
overflow-wrap: break-word;
}
h1 code {
background: transparent
}
pre {
background: transparent;
border: 0;
border-top: 1px solid #ccc;
border-bottom: 1px solid #ccc;
margin: 1em 0;
padding: 1ex;
}
#http-server-module-list {
display: flex;
flex-flow: column;
}
#http-server-module-list div {
display: flex;
}
#http-server-module-list dt {
min-width: 10%;
}
#http-server-module-list p {
margin-top: 0;
}
.toc ul,
#index {
list-style-type: none;
margin: 0;
padding: 0;
}
#index code {
background: transparent;
}
#index h3 {
border-bottom: 1px solid #ddd;
}
#index ul {
padding: 0;
}
#index h4 {
margin-top: .6em;
font-weight: bold;
}
/* Make TOC lists have 2+ columns when viewport is wide enough.
Assuming ~20-character identifiers and ~30% wide sidebar. */
@media (min-width: 200ex) {
#index .two-column {
column-count: 2
}
}
@media (min-width: 300ex) {
#index .two-column {
column-count: 3
}
}
dl {
margin-bottom: 2em;
}
dl dl:last-child {
margin-bottom: 4em;
}
dd {
margin: 0 0 1em 3em;
}
#header-classes+dl>dd {
margin-bottom: 3em;
}
dd dd {
margin-left: 2em;
}
dd p {
margin: 10px 0;
}
.name {
background: #000;
font-weight: bold;
font-size: .85em;
padding: 5px 10px;
display: inline-block;
min-width: 40%;
}
.name:hover {
background: #0b0b0b;
}
dt:target .name {
background: var(--highlight-color);
}
.name>span:first-child {
white-space: nowrap;
}
.name.class>span:nth-child(2) {
margin-left: .4em;
}
.inherited {
color: #999;
border-left: 5px solid #eee;
padding-left: 1em;
}
.inheritance em {
font-style: normal;
font-weight: bold;
}
.pydefname {
color: #f90;
}
/* Docstrings titles, e.g. in numpydoc format */
.desc h2 {
font-weight: 400;
font-size: 1.25em;
}
.desc h3 {
font-size: 1em;
}
.desc dt code {
background: inherit;
/* Don't grey-back parameters */
}
.source summary,
.git-link-div {
color: #666;
text-align: right;
font-weight: 400;
font-size: .8em;
text-transform: uppercase;
}
.source summary>* {
white-space: nowrap;
cursor: pointer;
}
.git-link {
color: inherit;
margin-left: 1em;
}
.source pre {
max-height: 500px;
overflow: auto;
margin: 0;
}
.source pre code {
font-size: 12px;
overflow: visible;
}
.hlist {
list-style: none;
}
.hlist li {
display: inline;
}
.hlist li:after {
content: ',\2002';
}
.hlist li:last-child:after {
content: none;
}
.hlist .hlist {
display: inline;
padding-left: 1em;
}
img {
max-width: 100%;
}
td {
padding: 0 .5em;
}
.admonition {
padding: .1em .5em;
margin-bottom: 1em;
}
.admonition-title {
font-weight: bold;
}
.admonition.note,
.admonition.info,
.admonition.important {
background: #00a;
}
.admonition.todo,
.admonition.versionadded,
.admonition.tip,
.admonition.hint {
background: #050;
}
.admonition.warning,
.admonition.versionchanged,
.admonition.deprecated {
background: #ec0;
}
.admonition.error,
.admonition.danger,
.admonition.caution {
background: #c20010;
}
p {
color: #fff;
}
</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>Euro-Truck-Simulator-2-Lane-Assist.src.loading</code></h1>
</header>
<section id="section-intro">
<p>Provides a loading window with a progress bar and a text label.</p>
<p>Usage: </p>
<pre><code class="language-python">loading = LoadingWindow(&quot;Loading...&quot;)
loading.update(progress=0.5, text=&quot;Loading 50%&quot;)
loading.update(progress=1, text=&quot;Loading 100%&quot;)
loading.destroy()
</code></pre>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">&#34;&#34;&#34;Provides a loading window with a progress bar and a text label.

Usage: 
```python
loading = LoadingWindow(&#34;Loading...&#34;)
loading.update(progress=0.5, text=&#34;Loading 50%&#34;)
loading.update(progress=1, text=&#34;Loading 100%&#34;)
loading.destroy()
```
&#34;&#34;&#34;
import tkinter as tk
from tkinter import ttk
import sv_ttk

class LoadingWindow:
    def __init__(self, text:str, master=None, progress:float=False, grab:bool=True, totalProgress:float=-1):
        &#34;&#34;&#34;Will create a loading window with a progress bar and a text label.

        Args:
            text (str): The text to display on the loading window.
            master (tkObject, optional): The master object. Otherwise we will create a new tk.Tk() object. Defaults to None.
            progress (bool / float, optional): If False, the progress bar will indeterminate. Otherwise input is from 0 to 1. Defaults to False.
            grab (bool, optional): Whether to grab the window focus. Defaults to True.
            totalProgress (float, optional): Will display another loading bar with the total progress. Defaults to -1.
        &#34;&#34;&#34;
        self.text = text
        self.progress = progress
        
        if master == None:
            self.root = tk.Tk()
        else:
            self.root = tk.Toplevel(master)
        
        def ignore():
            pass
            
        self.root.title(text)
        self.root.resizable(False, False)
        self.root.geometry(&#34;300x80&#34;)
        self.root.protocol(&#34;WM_DELETE_WINDOW&#34;, ignore)
        self.root.attributes(&#34;-topmost&#34;, True)
        if grab:
            self.root.focus_force()
            self.root.grab_set()

        self.label = ttk.Label(self.root, text=self.text)
        self.label.pack(pady=10)

        if progress == False:
            self.progress = ttk.Progressbar(self.root, orient=&#34;horizontal&#34;, length=200, mode=&#34;indeterminate&#34;)
            self.progress.start(10)
        else:
            self.progress = ttk.Progressbar(self.root, orient=&#34;horizontal&#34;, length=200, mode=&#34;determinate&#34;, value=progress)
        
        self.progress.pack(pady=10)
        
        if totalProgress != -1:
            self.totalProgress = ttk.Progressbar(self.root, orient=&#34;horizontal&#34;, length=200, mode=&#34;determinate&#34;, value=totalProgress)
            self.root.geometry(&#34;300x140&#34;)
            self.totalProgress.pack(pady=10)
        
        self.root.update()

    def destroy(self):
        try:
            del self.progress
            self.root.destroy()
        except:
            del self

    def update(self, progress:float=False, text:str=False, totalProgress:float=-1):
        &#34;&#34;&#34;Will update the loading window.

        Args:
            progress (float, optional): If a float is provided, the progress bar will be moved to the correct location. Defaults to False.
            text (str, optional): If a string is provided, the text will be updated. Defaults to False.
            totalProgress (float, optional): If a float is provided, will update the second loading bar. Defaults to -1.
        &#34;&#34;&#34;
        try:
            if progress != False:
                self.progress[&#34;value&#34;] = progress
            
            if text != False:
                self.label.config(text=text)
                
            if totalProgress != -1:
                self.totalProgress[&#34;value&#34;] = totalProgress
        except:
            pass
        
        self.root.update()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="Euro-Truck-Simulator-2-Lane-Assist.src.loading.LoadingWindow"><code class="flex name class">
<span>class <span class="ident">LoadingWindow</span></span>
<span>(</span><span>text: str, master=None, progress: float = False, grab: bool = True, totalProgress: float = -1)</span>
</code></dt>
<dd>
<div class="desc"><p>Will create a loading window with a progress bar and a text label.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>text</code></strong> :&ensp;<code>str</code></dt>
<dd>The text to display on the loading window.</dd>
<dt><strong><code>master</code></strong> :&ensp;<code>tkObject</code>, optional</dt>
<dd>The master object. Otherwise we will create a new tk.Tk() object. Defaults to None.</dd>
<dt>progress (bool / float, optional): If False, the progress bar will indeterminate. Otherwise input is from 0 to 1. Defaults to False.</dt>
<dt><strong><code>grab</code></strong> :&ensp;<code>bool</code>, optional</dt>
<dd>Whether to grab the window focus. Defaults to True.</dd>
<dt><strong><code>totalProgress</code></strong> :&ensp;<code>float</code>, optional</dt>
<dd>Will display another loading bar with the total progress. Defaults to -1.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class LoadingWindow:
    def __init__(self, text:str, master=None, progress:float=False, grab:bool=True, totalProgress:float=-1):
        &#34;&#34;&#34;Will create a loading window with a progress bar and a text label.

        Args:
            text (str): The text to display on the loading window.
            master (tkObject, optional): The master object. Otherwise we will create a new tk.Tk() object. Defaults to None.
            progress (bool / float, optional): If False, the progress bar will indeterminate. Otherwise input is from 0 to 1. Defaults to False.
            grab (bool, optional): Whether to grab the window focus. Defaults to True.
            totalProgress (float, optional): Will display another loading bar with the total progress. Defaults to -1.
        &#34;&#34;&#34;
        self.text = text
        self.progress = progress
        
        if master == None:
            self.root = tk.Tk()
        else:
            self.root = tk.Toplevel(master)
        
        def ignore():
            pass
            
        self.root.title(text)
        self.root.resizable(False, False)
        self.root.geometry(&#34;300x80&#34;)
        self.root.protocol(&#34;WM_DELETE_WINDOW&#34;, ignore)
        self.root.attributes(&#34;-topmost&#34;, True)
        if grab:
            self.root.focus_force()
            self.root.grab_set()

        self.label = ttk.Label(self.root, text=self.text)
        self.label.pack(pady=10)

        if progress == False:
            self.progress = ttk.Progressbar(self.root, orient=&#34;horizontal&#34;, length=200, mode=&#34;indeterminate&#34;)
            self.progress.start(10)
        else:
            self.progress = ttk.Progressbar(self.root, orient=&#34;horizontal&#34;, length=200, mode=&#34;determinate&#34;, value=progress)
        
        self.progress.pack(pady=10)
        
        if totalProgress != -1:
            self.totalProgress = ttk.Progressbar(self.root, orient=&#34;horizontal&#34;, length=200, mode=&#34;determinate&#34;, value=totalProgress)
            self.root.geometry(&#34;300x140&#34;)
            self.totalProgress.pack(pady=10)
        
        self.root.update()

    def destroy(self):
        try:
            del self.progress
            self.root.destroy()
        except:
            del self

    def update(self, progress:float=False, text:str=False, totalProgress:float=-1):
        &#34;&#34;&#34;Will update the loading window.

        Args:
            progress (float, optional): If a float is provided, the progress bar will be moved to the correct location. Defaults to False.
            text (str, optional): If a string is provided, the text will be updated. Defaults to False.
            totalProgress (float, optional): If a float is provided, will update the second loading bar. Defaults to -1.
        &#34;&#34;&#34;
        try:
            if progress != False:
                self.progress[&#34;value&#34;] = progress
            
            if text != False:
                self.label.config(text=text)
                
            if totalProgress != -1:
                self.totalProgress[&#34;value&#34;] = totalProgress
        except:
            pass
        
        self.root.update()</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="Euro-Truck-Simulator-2-Lane-Assist.src.loading.LoadingWindow.destroy"><code class="name flex">
<span>def <span class="ident">destroy</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def destroy(self):
    try:
        del self.progress
        self.root.destroy()
    except:
        del self</code></pre>
</details>
</dd>
<dt id="Euro-Truck-Simulator-2-Lane-Assist.src.loading.LoadingWindow.update"><code class="name flex">
<span>def <span class="ident">update</span></span>(<span>self, progress: float = False, text: str = False, totalProgress: float = -1)</span>
</code></dt>
<dd>
<div class="desc"><p>Will update the loading window.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>progress</code></strong> :&ensp;<code>float</code>, optional</dt>
<dd>If a float is provided, the progress bar will be moved to the correct location. Defaults to False.</dd>
<dt><strong><code>text</code></strong> :&ensp;<code>str</code>, optional</dt>
<dd>If a string is provided, the text will be updated. Defaults to False.</dd>
<dt><strong><code>totalProgress</code></strong> :&ensp;<code>float</code>, optional</dt>
<dd>If a float is provided, will update the second loading bar. Defaults to -1.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def update(self, progress:float=False, text:str=False, totalProgress:float=-1):
    &#34;&#34;&#34;Will update the loading window.

    Args:
        progress (float, optional): If a float is provided, the progress bar will be moved to the correct location. Defaults to False.
        text (str, optional): If a string is provided, the text will be updated. Defaults to False.
        totalProgress (float, optional): If a float is provided, will update the second loading bar. Defaults to -1.
    &#34;&#34;&#34;
    try:
        if progress != False:
            self.progress[&#34;value&#34;] = progress
        
        if text != False:
            self.label.config(text=text)
            
        if totalProgress != -1:
            self.totalProgress[&#34;value&#34;] = totalProgress
    except:
        pass
    
    self.root.update()</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="Euro-Truck-Simulator-2-Lane-Assist.src" href="index.html">Euro-Truck-Simulator-2-Lane-Assist.src</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="Euro-Truck-Simulator-2-Lane-Assist.src.loading.LoadingWindow" href="#Euro-Truck-Simulator-2-Lane-Assist.src.loading.LoadingWindow">LoadingWindow</a></code></h4>
<ul class="">
<li><code><a title="Euro-Truck-Simulator-2-Lane-Assist.src.loading.LoadingWindow.destroy" href="#Euro-Truck-Simulator-2-Lane-Assist.src.loading.LoadingWindow.destroy">destroy</a></code></li>
<li><code><a title="Euro-Truck-Simulator-2-Lane-Assist.src.loading.LoadingWindow.update" href="#Euro-Truck-Simulator-2-Lane-Assist.src.loading.LoadingWindow.update">update</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>